<!DOCTYPE html>
<html>
 <head>
  <title>
   Contribute to PixieDust
  </title>
  <meta content="&#xA9;Copyright IBM Corporation 2018" name="copyright"/>
  <meta content="&#xA9;Copyright IBM Corporation 2018" name="DC.Rights.Owner"/>
  <meta content="&#xA9; Copyright IBM Corporation 2016, 2017, 2018" name="dcterms.rights"/>
  <meta content="2018-03-09" name="DC.date"/>
 </head>
 <body>
  <div>
   <h1>
    Contribute to PixieDust
   </h1>
   <p>
    PixieDust is under active development and welcomes contributions and participations from all individuals regardless of skill level. Whether you like to review documentation or implement new features, there's a lot you can do.
   </p>
   <div>
    <h1>
     Create an Issue
    </h1>
    <p>
     Create an issue if you find:
    </p>
    <ul>
     <li>
      <p>
       any problems that you are unable to fix
      </p>
     </li>
     <li>
      <p>
       documentation that's hard to follow
      </p>
     </li>
     <li>
      <p>
       inconsistencies in code, user interface, or documentation
      </p>
     </li>
    </ul>
    <p>
     You can create issues in the
     <a href="https://github.com/ibm-cds-labs/pixiedust/issues">
      PixieDust GitHub repository
     </a>
     . To minimize duplicates, please review exising issues and search for your problem before creating a new issue.
    </p>
   </div>
   <div>
    <h1>
     Create a Pull Request
    </h1>
    <p>
     If you're pitching in and fixed an issue or added a new feature (bravo!) please submit a
     <a href="https://github.com/ibm-cds-labs/pixiedust/pulls">
      pull request
     </a>
     . All pull requests are welcome and will be reviewed by the PixieDust maintainers before being accepted/merged.
    </p>
    <p>
     If you're new to GitHub or unfamiliar with pull requests, watch the
     <a href="https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github">
      How to Contribute to an Open Source Project on GitHub
     </a>
     video series.
    </p>
    <p>
     Here are the steps for working with the
     <a href="https://github.com/ibm-cds-labs/pixiedust/issues">
      PixieDust GitHub repository
     </a>
     . (These instructs assume you have PixieDust set up and are ready to
     <a href="develop.html">
      start development
     </a>
     ).
    </p>
    <ol>
     <li>
      <p>
       If you haven't already,
       <a href="https://guides.github.com/activities/forking/">
        fork
       </a>
       the PixieDust repository.
      </p>
     </li>
     <li>
      <p>
       Create a
       <a href="http://guides.github.com/introduction/flow/">
        branch
       </a>
       for your changes.
      </p>
     </li>
     <li>
      <p>
       Make the edits in your branch.
      </p>
     </li>
     <li>
      <p>
       <a href="test.html">
        Test
       </a>
       to make sure your changes do not break existing behavior.
      </p>
     </li>
     <li>
      <p>
       Repeat steps 3 and 4 until you are ready to submit your updates.
      </p>
     </li>
     <li>
      <p>
       <a href="https://help.github.com/articles/creating-a-pull-request/">
        Submit a pull request
       </a>
       .
      </p>
     </li>
    </ol>
    <blockquote>
     <strong>
      Note
     </strong>
     <p>
      While you work, regularly pull in changes from the PixieDust 'master' stream so you stay up-to-date and minimize merge conflicts when you submit your pull request.
      <a href="https://help.github.com/articles/syncing-a-fork">
       See detailed instructions
      </a>
      .
     </p>
    </blockquote>
   </div>
   <div>
    <h1>
     Where we need help
    </h1>
    <p>
     Here are the visualizations and renderers we have so far:
    </p>
    <table>
     <tr>
      <td>
      </td>
      <td>
       <strong>
        Bar Chart
       </strong>
      </td>
      <td>
       <strong>
        Pie Chart
       </strong>
      </td>
      <td>
       <strong>
        Line Graph
       </strong>
      </td>
      <td>
       <strong>
        Scatter Plot
       </strong>
      </td>
      <td>
       <strong>
        Histogram
       </strong>
      </td>
      <td>
       <strong>
        Map
       </strong>
      </td>
     </tr>
     <tr>
      <td>
       matplotlib
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
     </tr>
     <tr>
      <td>
       Seaborn
      </td>
      <td>
      </td>
      <td>
      </td>
      <td>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       NA
      </td>
     </tr>
     <tr>
      <td>
       Bokeh
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
      <td>
       NA
      </td>
     </tr>
     <tr>
      <td>
       MapBox
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
     </tr>
     <tr>
      <td>
       Google Maps
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       NA
      </td>
      <td>
       <img src="https://raw.githubusercontent.com/ibm-watson-data-lab/pixiedust/master/docs/_images/chmk.png"/>
      </td>
     </tr>
    </table>
    <p>
     Choose a project, pitch in, and help us complete every component here. Or come up with your own enhancement. Let us know. We'd love to see your work.
    </p>
   </div>
   <p>
    <h3>
     Return to main topic for:
    </h3>
    <ul>
     <li>
      <a href="develop.html">
       Develop for PixieDust
      </a>
     </li>
    </ul>
   </p>
  </div>
 </body>
</html>
